Skip to content

Conversation

jnavila
Copy link

@jnavila jnavila commented Sep 7, 2025

  • Switch the synopsis to a synopsis block which will automatically format placeholders in italics and keywords in monospace
  • Use instead of in the description
  • Use backticks for keywords and more complex option descriptions. The new rendering engine will apply synopsis rules to these spans.

Also add the CONFIGURATION section when it is missing and do not refer to the man page in the description of settings when this list is included in the manual page.

- Switch the synopsis to a synopsis block which will automatically
  format placeholders in italics and keywords in monospace
- Use _<placeholder>_ instead of <placeholder> in the description
- Use `backticks` for keywords and more complex option
descriptions. The new rendering engine will apply synopsis rules to
these spans.

Also do not refer to the man page in the description of settings when this
description is already in the man page.

Signed-off-by: Jean-Noël Avila <[email protected]>
- Switch the synopsis to a synopsis block which will automatically
  format placeholders in italics and keywords in monospace
- Use _<placeholder>_ instead of <placeholder> in the description
- Use `backticks` for keywords and more complex option
descriptions. The new rendering engine will apply synopsis rules to
these spans.

Also add the config section in the manual page and do not refer to the man
page in the description of settings when this description is already in the
man page.

Signed-off-by: Jean-Noël Avila <[email protected]>
- Switch the synopsis to a synopsis block which will automatically
  format placeholders in italics and keywords in monospace
- Use _<placeholder>_ instead of <placeholder> in the description
- Use `backticks` for keywords and more complex option
descriptions. The new rendering engine will apply synopsis rules to
these spans.

Also add the config section in the manual page and do not refer to the man
page in the description of settings when this description is already in the
man page.

Signed-off-by: Jean-Noël Avila <[email protected]>
@jnavila jnavila changed the title doc: convert git-stash.adoc to synopis style doc: convert git-stash, git tag and git worktree to synopis style Oct 5, 2025
@jnavila
Copy link
Author

jnavila commented Oct 5, 2025

/submit

Copy link

gitgitgadget bot commented Oct 5, 2025

Submitted as [email protected]

To fetch this version into FETCH_HEAD:

git fetch https://github.com/gitgitgadget/git/ pr-1969/jnavila/doc_git_stash-v1

To fetch this version to local tag pr-1969/jnavila/doc_git_stash-v1:

git fetch --no-tags https://github.com/gitgitgadget/git/ tag pr-1969/jnavila/doc_git_stash-v1

Copy link

gitgitgadget bot commented Oct 6, 2025

This patch series was integrated into seen via git@788f2cc.

@gitgitgadget gitgitgadget bot added the seen label Oct 6, 2025
Copy link

gitgitgadget bot commented Oct 7, 2025

This branch is now known as jn/doc-synopsis.

Copy link

gitgitgadget bot commented Oct 7, 2025

This patch series was integrated into seen via git@2db5a8b.

Copy link

gitgitgadget bot commented Oct 8, 2025

This patch series was integrated into seen via git@7b2890d.

Copy link

gitgitgadget bot commented Oct 8, 2025

This patch series was integrated into next via git@fd4f96f.

@gitgitgadget gitgitgadget bot added the next label Oct 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant